home *** CD-ROM | disk | FTP | other *** search
/ Aminet 30 / Aminet 30 (1999)(Schatztruhe)[!][Apr 1999].iso / Aminet / dev / basic / orionircsrc.lha / OrionIRC / orionirc.doc < prev    next >
Text File  |  1998-12-16  |  11KB  |  356 lines
  1.  
  2. Short: An IRC Client Pre-Release
  3. Author: amiga@ticon.net (Andrew Drays)
  4. uploader: amiga@ticon.net (Andrew Drays)
  5. Version: 0.07
  6. Type: comm/irc
  7. WebPage: http://www.ticon.net/~amiga
  8.  
  9. --------------
  10.  Description: 
  11. --------------
  12.  
  13. OrionIRC is my idea which will be soon splitting into a couple other
  14. programs as Well as OrionIRC..
  15.  
  16. A Gadtools IRC.. which is about 20% faster then AmIrc
  17.  
  18. All chennels are handled in one window, when you have too many windows and
  19. queries open.. it tends to get cluttered.. click on the channel you wish to
  20. talk in to talk in it.. .. it's pretty self explanitory.. 
  21.  
  22. All Written in BlitzBasic ..
  23.  
  24. ********
  25.  
  26. WARNING this Doc is a cut and paste and incomplete!!!
  27.  
  28. This is an official pre-release.. to bolster and hopefully boost support..
  29.  
  30. if I get e-mails and questions and encouragement to continue my work.. I
  31. will, otherwise, I may just make the IRCdaemon.. which may be of more
  32. original work then just "another" IRC client.. 
  33.  
  34. with the recent release of BlackIRC, I felt I needed to show my progress..
  35.  
  36. YES, the executeable is big, but please remember, it has a runtime debugger
  37. included to prevent crashing your system!
  38.  
  39. it should generally be safe, if you have any problems, or if any errors
  40. arise, please, let me know, and I will be eager to fix them, also let me
  41. know if you have any ideas for the program.. I would be glad to hear
  42. them.. if you have any questions, please E-mail me.. and I'll answer
  43. them or find me in IRC!
  44.  
  45. I believe I have the program generally bug free... but I've been known to
  46. be wrong.. please don't shoot me if I am :)
  47.  
  48. the Config file is generally compatible with Amirc's .. take a look and
  49. edit it to your taste.. and it should work.. :) in the end, it will be 100%
  50. compatible.. (I hope)
  51.  
  52. :)
  53.  
  54. useable commands 
  55.  
  56. /msg (may not work at present, best to query)
  57. /query
  58. /part
  59. /join
  60. /quit
  61. /nick
  62.  
  63. toggles
  64.  
  65. /bot
  66. /speak
  67. /color
  68.  
  69. ** 
  70.  
  71. Known problem: may not work w/a gfx card.. simple to fix let me know if
  72. you have any problems.. just add a "1" (just the digit, no quotes!) to the
  73. end of the ORIC.CFG in your env: .. which contains screen mode info.. :)
  74.  
  75. ******
  76.  
  77. -----------
  78.  Shareware
  79. -----------
  80.  
  81.     Yes, I'm asking for money.. $10.. and you'll get a personalized version
  82. and all future updates.. 
  83.  
  84. and you'll be making an investment into all my future developments.. 
  85.  
  86. OrionIRC - IRC program with Orionbot built in...
  87.  
  88. OrionIRCDaemon .. IRC server Daemon with OrionBot built in..
  89.  
  90. if you use this program regularly,
  91.  
  92. Please send $10 to:
  93.  
  94. OrionSoft LTD
  95. c/o Andrew Drays
  96. 2624 King Street
  97. Janesville, WI 
  98.                53546
  99.  
  100.  
  101. --------------
  102.  Requirements
  103. --------------
  104.  
  105. As far as I know,
  106.  
  107. any Amiga running a TCP stack with Miami or AmiTCP equivelant TCP stack
  108. .. andy chipset or GFX card.. 
  109. "bsdsocket.library"
  110.  
  111. Your memory requirements will rise as more random lines and greetings you
  112. have.. 
  113.  
  114. ----------
  115.  Features
  116. ----------
  117.  
  118. BOT & IRC
  119.  
  120. Easy to configure
  121. Fast Response (actually FASTER then OrionBOT!)
  122. AI - Simple but fun (uses an old ELIZA routine!)
  123. Random Text display
  124. Random Sleep timer
  125. Random Greetings
  126. Multi User Access
  127. Text Encryption
  128.  
  129. --------------
  130.  Legal Stuff:
  131. --------------
  132.  
  133.     if you run it.. and it blows up your computer.. it's your problem, not
  134. mine.. I designed it to be a simple bot.. not a virus.. don't bother suing
  135. me for any damages.. 
  136.  
  137. I will attempt to fix any minor problems in my program that may arise from
  138. the use of my program.. 
  139.  
  140. although there is a runtime debugger included, it does NOT guarantee you
  141. won't guru!
  142.  
  143. --------------
  144.  Installation
  145. --------------
  146.  
  147. It needs the TOSFONTS in the FONTS: dir.. otherwise, all the rest of the
  148. files need to reside in the same directory the program is in..
  149.  
  150. ------------------
  151.  Options & Config
  152. ------------------
  153.  
  154. the Program is pretty self sufficient.. and will run by itself without any
  155. files, but there are some config files you may wish to have setup.. 
  156.  
  157. default: greet.cfg
  158.  
  159. ----
  160. 6. This is the file that is a relief to many of my beta testers, and a
  161.    godsend to myself, also.. the multiuser access file.. it contains 3
  162.    simple lines.. 
  163.  
  164.    Nick 1          . whatever your nick is
  165.    password 1      . your password
  166.    access 2        . anything from 10 to 99 .. it don't care
  167.    nick 2          . a friends nick
  168.    password 2      . his password
  169.    access 2        . his access below 10?
  170.    nick 3
  171.    etc..
  172.  
  173.    each line set up in a way so that more then one person can access the
  174.    bot and it's abilities..the people you give access to your bot know to
  175.    off "offme" thier access when thier done for the day so other people
  176.    don't log on with thier nick and use thier access.. 
  177.  
  178.    access levels are hard coded as of this version.. maybe later it'll be
  179.    different.. level 1 to 99.. as shown in the commands menu.. 
  180.  
  181. ** Future Versions will contain IP security .. 
  182.  
  183. default: access.cfg
  184.  
  185. ----
  186. 7. you might wanna leave this file alone.. it can have upto 50 lines of text
  187.    80 characters wide... and have it display any way you wish.. never
  188.    versions will have configureable access levels per command so to keep
  189.    yourself from haveing to re-write thsi file later.. just leave it be.. 
  190.    the longer you make it the longer it takes to display..
  191.  
  192. ** I built a display delay timer into OrionBot to keep it from flooding
  193.    out.. although it can display 50 lines.. I suggest you keep it to
  194.    under 20.. I may lower this in the future anyways..
  195.  
  196. default: command.menu
  197.  
  198. ----
  199. 8. this is the file name that you use for the bot to spit out random
  200.    text.. one liners basicly.. I use an old taglines file, myself..
  201.    the file line limit is 5000 lines.. granting you have enough memory for
  202.    THAT many lines.. 
  203.  
  204. default: oneline.bot
  205.  
  206. ----
  207. 9. your command prefix character.. the program will only read 1 character
  208.    from this line so you can't have multiple command headers.. I.e. $% or
  209.    anything like that, sorry.. 
  210.  
  211. default: -
  212.  
  213. ----
  214. 10. This defines how many line go by in the IRC, that the BOT sees that
  215.     someone with an IP said something, before it splurts out some nonsense
  216.     from it's oneline file.. if you want to turn this option off just put
  217.     a "-1" in this line.. and it won't blurb anything out, but the "random"
  218.     option will still be active.. 
  219.  
  220. default: 20
  221.  
  222. ----
  223. 12. This is an actual Switch that controls 2 functions.. testmode and
  224.     random sleep timer.. it will accept one of three numbers for it's
  225.     arguments.. if it's not one of the three numbers.. it defaults to 0..
  226.  
  227.     0 turns off sleep timer and test mode
  228.     1 turns on test mode
  229.     2 turns on sleep timer
  230.  
  231.     0 is self explanitory after 1 and 2 are explained
  232.  
  233.     1 this is a test mode for the bot, you need not run your TCP stack to
  234.       use this option, as it doesn't access IRC when this is on.. 
  235.  
  236.       Test mode is something I made for myself, but I figure it might come
  237.       in handy for other people to use if they're encountering a problem
  238.       with orionbot..  it access all the data files on the system, and
  239.       displays what is in them, prompting the for use input on each file
  240.       for verbosity.. you may not want it to display all 200+ lines of your
  241.       random file.. so you can see where potential errors may be on why
  242.       OrionBot is messing up for bug reports.. 
  243.  
  244.       it also diplays all the colors to oyu can pick which color you want
  245.       displayed in option #13..
  246.  
  247.     2 if there's no activity in a channel for about 30 seconds the bot will
  248.       pipe up with "random".. maybe to spark someone to talk about the
  249.       funny line that came up and get conversation going.. thus waking up
  250.       "sleepers".. 
  251.  
  252.  
  253. ---------------
  254.  Command Menu:
  255. ---------------
  256.  
  257. * future options? (only with support!)
  258.  
  259. - Level 99 - bye, raw, goto, *set, say, ncrypt
  260.  
  261. - Level 10 - *addnick, *remnick, op, dop, opme, kick
  262.  
  263. - Level 1 - say, *tryme, offme
  264.  
  265. - None - version, VERSION, random, users, commands, pass
  266.  
  267. raw          . Send raw data to the server <only if you KNOW>
  268. bye          . quit the bot via IRC
  269. set          * change a certain setting on the bot
  270. addnick      * add a person to the access list
  271. remnick      * remove a person form the access list
  272. say          . say something to the channel it's in.. 
  273. goto         . go to a channel
  274. opme         . if the bot is an op.. to have it op you
  275. op <nick>    . " .. to have it op <nick>
  276. dop <nick>   . " .. have it deop <nick>
  277. ncrypt <?>   . have it encrypt text (don't do it if it annoys others)
  278. commands     . menu of available commands
  279. owner <nick> . transfer ownership fo the bot so someone else
  280. random       . do a random oneliner
  281. pass <pass>  . turn on bot access if your on the user list via password 
  282. offme        . turn off your access
  283. tryme        * random oneliner to person then random kick choice
  284.  
  285. I wouldn't suggest using this bot as a channel monitor quite yet.. it COULD
  286. be used as one but, it has flaws..
  287.  
  288. at current it only uses a nickname as an identifier.. if someone has
  289. your nickname, and password they can access it.. or if you leave the
  290. channel, or ping out of a channel, your access is still acitvated, a person
  291. could easily take over your channel.. it doesn't have a routine to
  292. deactivate a person leaving a channel yet.. my to do list is pretty
  293. extensive, with security procedures at the top.. this is meant as a bot
  294. for fun...
  295.  
  296. Enjoy!
  297.  
  298.  
  299. -----
  300.  GUI
  301. -----
  302.  
  303. The Gui For the Bot isn't very complex... for futue concepts and ideas, the
  304. bot opens on it's own 16 color screen.. there's a 3 options in the pull
  305. down menu.. CLI, ABOUT, and QUIT.. all I think are self explanitory and
  306. easy to use.. 
  307.  
  308.  
  309. --------
  310.  Future
  311. --------
  312.  
  313. As Stealth put it.. "Frills" ... Games like Trivia.. maybe tic tac toe.. ..
  314. whatever I can find in a "basic" that's text based for me to convert.. 
  315.  
  316.  
  317. ------------------------------------
  318.  Problems and Bug Reports and IDEAS
  319. ------------------------------------
  320.  
  321. Simply E-mail me with the problem.. but before ya go doing that, be sure to
  322. take a look at the "Bot.log" on your system.. it will have a detailed list
  323. of server to bot activity.. 
  324.  
  325. be sure to send this file with the bot problem information...
  326.  
  327.  
  328. --------
  329.  Thanks
  330. --------
  331.  
  332. Many Special thanx to my good Friends in #amirc on the Undernet!!
  333. (Listed in Alphabetical order)
  334. Cav
  335. Funkman (beta Tester)
  336. Splatt
  337. Grog
  338. Stealth (beta tester)
  339. Zonkerz
  340.  
  341. People from Blitz list!
  342.  
  343. Paul Burkey for the code to work from...
  344. Curt Esser for special source code.. 
  345.  
  346. And Many Many thanks to the BLitz List for whom which this would not be
  347. possible.. 
  348.  
  349. ----------------------
  350.  Progress & Versions:
  351. ----------------------
  352.  
  353. too many!
  354.  
  355. EOF
  356.